fix: ensure posix path sep is used #728
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
svidgen
previously approved these changes
Oct 2, 2023
alharris-at
approved these changes
Oct 2, 2023
svidgen
approved these changes
Oct 2, 2023
Comment on lines
+5
to
+9
| const relativePath = path | ||
| .relative(opsGenDirectory, generatedFileName) | ||
| // ensure posix path separators are used | ||
| .split(path.win32.sep) | ||
| .join(path.posix.sep); |
There was a problem hiding this comment.
I suspect this is OK. But, is there any possibility that this affects any other downstream consumers of the relativePath in unintended (negative) ways?
There was a problem hiding this comment.
All path and fs functions accept posix style paths even on a windows machine. So I think it should be fine.
There was a problem hiding this comment.
i.e.
> path.resolve('./packages/graphql-generator/package.json')
D:\\Users\\dppilche\\amplify-codegen\\packages\\graphql-generator\\package.json
There was a problem hiding this comment.
I'm more so wondering if we do any path splitting or merging that could break due to it looking for os delimiting.
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
Alternative to #727
See https://github.com/aws-amplify/amplify-cli/issues/13289 for details.
path.relativebehaves differently on windows. https://nodejs.org/api/path.html#pathrelativefrom-toThis results in the generated path being invalid syntax in TypeScript/JavaScript.
This change replaces the windows path separator (
path.win32.sep) with the posix path separator (path.posix.sep).Issue #, if available
https://github.com/aws-amplify/amplify-cli/issues/13289
Description of how you validated changes
Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.